/*
 * This file is part of aion-engine <aion-engine.com>
 *
 * aion-engine is private software: you can redistribute it and or modify
 * it under the terms of the GNU Lesser Public License as published by
 * the Private Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * aion-engine is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Lesser Public License for more details.
 *
 * You should have received a copy of the GNU Lesser Public License
 * along with aion-engine.  If not, see <http://www.gnu.org/licenses/>.
 */
package com.aionengine.gameserver.model.templates.housing;

import javax.xml.bind.annotation.*;

/**
 * @author Rolandas
 */
@XmlAccessorType(XmlAccessType.FIELD)
@XmlType(name = "PlaceableHouseObject")
@XmlSeeAlso(
        {
                HousingJukeBox.class, HousingPicture.class, HousingPostbox.class,
                HousingChair.class, HousingStorage.class, HousingNpc.class, HousingMoveableItem.class,
                HousingUseableItem.class, HousingPassiveItem.class, HousingEmblem.class
        })
public abstract class PlaceableHouseObject extends AbstractHouseObject {

    @XmlAttribute(name = "use_days")
    protected Integer useDays;

    @XmlAttribute
    protected LimitType limit;

    @XmlAttribute
    protected PlaceLocation location;

    @XmlAttribute
    protected PlaceArea area;

    /**
     * Gets the value of the useDays property.
     *
     * @return null if not restricted
     */
    public int getUseDays() {
        if (useDays == null)
            return 0;
        return useDays;
    }

    /**
     * Where the object is allowed to be placed on?
     * <p/>
     * <tt>TODO: check if it is needed and not handled by the client</tt>
     *
     * @return {@link LimitType.NONE} if no restriction
     */
    public LimitType getPlacementLimit() {
        if (limit == null)
            return LimitType.NONE;
        return limit;
    }

    /**
     * How the object is allowed to be placed (stacks, ground, wall) ?
     * <p/>
     * <tt>TODO: check if it is needed and not handled by the client</tt>
     *
     * @return possible object is {@link PlaceLocation }
     */
    public PlaceLocation getLocation() {
        return location;
    }

    /**
     * Environment where the object is allowed to be placed (interior, exterior)
     * <p/>
     * <tt>TODO: check if it is needed and not handled by the client</tt>
     *
     * @return possible object is {@link PlaceArea }
     */
    public PlaceArea getArea() {
        return area;
    }

    public abstract byte getTypeId();

}
